package com.ng.common.config;

import com.ng.common.interceptor.JwtTokenInterceptor;
import com.ng.common.utils.JacksonObjectMapper;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

import javax.annotation.Resource;
import java.util.List;

/**
 * 配置类，注册web层相关组件
 * WebMvcConfigurationSupport是Spring MVC框架提供的一个配置类，用于扩展和自定义Web MVC的配置。
 * 当需要对Spring MVC的配置进行更高级别的自定义时，可以创建一个继承自WebMvcConfigurationSupport的配置类，并重写其中的方法来进行配置。
 * WebMvcConfigurationSupport提供了一些方法，可以用于配置处理器映射、拦截器、消息转换器、静态资源处理等。以下是其中一些常用的方法：
 * configurePathMatch(PathMatchConfigurer configurer)：用于配置路径匹配规则。
 * addInterceptors(InterceptorRegistry registry)：用于添加自定义的拦截器。
 * addCorsMappings(CorsRegistry registry)：用于配置跨域资源共享（CORS）。
 * configureMessageConverters(List<HttpMessageConverter<?>> converters)：用于配置消息转换器。
 * addResourceHandlers(ResourceHandlerRegistry registry)：用于配置静态资源处理。
 * extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers)：用于扩展处理器异常解析器。
 * 通过继承WebMvcConfigurationSupport，可以重写这些方法，并进行相应的配置。例如，可以添加自定义的拦截器来实现权限验证、日志记录等功能；
 * 配置消息转换器来支持不同的数据格式；处理静态资源请求等。
 * 需要注意的是，当使用WebMvcConfigurationSupport时，需要手动配置Spring MVC的一些默认行为，因为它会覆盖Spring Boot的自动配置。
 * 如果只需要进行一些简单的配置，而不是全面地重写Spring MVC的配置，推荐使用WebMvcConfigurer接口或注解方式进行配置，
 * 这样可以保留Spring Boot的自动配置能力。
 * 总而言之，WebMvcConfigurationSupport是Spring MVC框架提供的一个配置类，用于扩展和自定义Web MVC的配置。通过继承该类并重写其中的方法，
 * 可以进行更高级别的Spring MVC配置。
 *
 * @author Ng
 * @date 2024/03/08
 */
@Configuration
public class WebMvcConfiguration extends WebMvcConfigurationSupport {

    @Resource
    private JwtTokenInterceptor jwtTokenInterceptor;

    /**
     * 注册自定义拦截器
     * @param registry InterceptorRegistry
     */
    protected void addInterceptors(InterceptorRegistry registry) {

        // 开始注册自定义拦截器..
        registry.addInterceptor(jwtTokenInterceptor)
                .addPathPatterns("/user/**")
                .excludePathPatterns("/user/login")
                .excludePathPatterns("/user/status");
        // 完成注册自定义拦截器..
    }

    /**
     * 通过 knife4j 生成接口文档
     * @return Docket
     */
//    @Bean
//    public Docket docket() {
//
//        ApiInfo apiInfo = new ApiInfoBuilder()
//                .title("项目接口文档")
//                .version("2.0")
//                .description("项目接口文档")
//                .build();
//        Docket docket = new Docket(DocumentationType.SWAGGER_2)
//                .groupName("接口")
//                .apiInfo(apiInfo)
//                .select()
//                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
//                .paths(PathSelectors.any())
//                .build();
//
//        return docket;
//    }

    /**
     * 设置静态资源映射
     * @param registry ResourceHandlerRegistry
     */
//    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
//
//        // 开始设置静态资源映射..
//        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
//        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
//    }

    /**
     * 扩展 Spring MVC 框架消息转换器
     * @param converters List<HttpMessageConverter<?>>
     */
    @Override
    protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {

        // 扩展消息准换器..
        // 创建一个MappingJackson2HttpMessageConverter实例，并设置自定义的ObjectMapper
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        // 将自己创建的对象转换器添加进去，该对象可以将java对象序列化准换为json数据
        converter.setObjectMapper(new JacksonObjectMapper());
        // 将自己的消息转换器假如容器中，并设置第一个位置，让他优先级更高
        converters.add(0, converter);
    }
}
